/*******************************************************************************
 * Copyright 2009, 2010 Innovation Gate GmbH. All Rights Reserved.
 * 
 * This file is part of the OpenWGA server platform.
 * 
 * OpenWGA is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 * 
 * In addition, a special exception is granted by the copyright holders
 * of OpenWGA called "OpenWGA plugin exception". You should have received
 * a copy of this exception along with OpenWGA in file COPYING.
 * If not, see <http://www.openwga.com/gpl-plugin-exception>.
 * 
 * OpenWGA is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with OpenWGA in file COPYING.
 * If not, see <http://www.gnu.org/licenses/>.
 ******************************************************************************/

package de.innovationgate.wgpublisher.design;

import de.innovationgate.webgate.api.WGDatabase;
import de.innovationgate.webgate.api.WGDesignProvider;
import de.innovationgate.webgate.api.WGDocumentCore;
import de.innovationgate.webgate.api.WGException;
import de.innovationgate.wga.config.DesignReference;

/**
 * WGA specific extension to the {@link WGDesignProvider} interface
 */
public interface WGADesignProvider extends WGDesignProvider {
    
    public static final String OPTION_DESIGNVARIANTS = "variants";
    
    /**
     * Returns if the provider is configured to lookup design variants
     */
    public boolean isLookupVariants();
    
    /**
     * Returns the database that consumes the designs of this provider
     */
    public WGDatabase getConsumerDatabase();
    
    
    /**
     * A design provider may notify via this method if the design backend is currently ready
     */
    public boolean isReady();
    
    /**
     * Clears all design caches
     * @throws WGException 
     */
    public void clearCache() throws WGException;

}
